/*
    Copyright (C) 2007 JSPWiki Developer Group

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
 */
package erwiki.plugins;

import java.util.Map;

import erwiki.api.WikiPartReference;
import erwiki.api.admin.ui.TemplateManager;
import erwiki.api.core.Engine;
import erwiki.api.core.WikiContext;
import erwiki.api.exceptions.PluginException;
import erwiki.api.plugin.PluginManager;
import erwiki.api.plugin.WikiPlugin;
import erwiki.configuration.IWikiConfiguration;
import erwiki.util.TextUtil;

/**
 * Плагин ErWiki. Выводит изображение с предоставленным текстом в качестве <tt>title</tt>, который в
 * большинстве случаев отображается в виде всплывающей подсказки браузеров. Предназначен для
 * коротких однострочных комментариев.
 * <p>
 * См. http://www.456bereastreet.com/archive/200412/the_alt_and_title_attributes/ для обсуждения
 * атрибутов <em>alt</em> и <em>title</em>.
 * <p>
 * Адаптация CommentPlugin, написанный Скоттом Халбертом, очищенная и обобщенная, но в основном его
 * концепция.
 * <p>
 * Параметры плагина:
 * <ul>
 * <li><b>_cmdline</b> - текст комментария.</li>
 * </ul>
 *
 * @author Scott Hulbert
 */
public class NotePlugin implements WikiPlugin {

	/** Имя свойства для установки изображения заметки. Значение <tt>{@value}</tt>. */
	public static final String PROP_NOTE_IMAGE = "notePlugin.imageName";

	/** Имя изображения заметки, по умолчанию. Значение <tt>{@value}</tt>. */
	public static final String DEFAULT_NOTE_IMAGE = "note.png";

	@Deprecated
	private IWikiConfiguration wikiConfiguration;
	// this.wikiConfiguration = null; // :FVK: -workaround. engine.getWikiConfiguration();

	@WikiPartReference
	private Engine engine;

	@WikiPartReference
	private TemplateManager templateManager;

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String execute(WikiContext context, Map<String, String> params) throws PluginException {
		String commandline = params.get(PluginManager.PARAM_CMDLINE);
		if (commandline == null || commandline.length() == 0) {
			return "Unable to obtain plugin command line from parameter'" + PluginManager.PARAM_CMDLINE + "'"; // I18N
		}

		String commentImage = imageUrl(context);

		String commentText = clean(commandline);

		return "<img src='" + commentImage + "' alt=\"Comment: " + commentText + "\" title=\"" + commentText + "\"/>";
	}

	/**
	 * Формирует ссылку на изображение.
	 *
	 * @param ctx вики-контекст.
	 * @return
	 */
	private String imageUrl(WikiContext ctx) {
		// TODO: реализовать preference page для этого плагина
		String commentImage = wikiConfiguration.getStringProperty(PROP_NOTE_IMAGE, DEFAULT_NOTE_IMAGE);
		commentImage = "images/" + commentImage;

		String templateDir = this.engine.getTemplateDir();
		String resource = this.templateManager.findResource(ctx, templateDir, commentImage);

		// JSPWIKI-876 Fixed error with Note Plugin. Only one preceding "/" is needed.
		if (resource != null && resource.startsWith("/")) {
			resource = resource.substring(1);
		}
		return ctx.getURL(WikiContext.PAGE_NONE, resource);
	}

	/**
	 * Cleans the side.
	 *
	 * @param commandline
	 */
	private String clean(String commandline) {
		return TextUtil.replaceEntities(commandline);
	}

}
